Add DOMAIN_NAME for networks #34

Jean-Beru · 2016-10-31T10:23:17Z

Resolves #32

Add the possibility to add a DOMAIN_NAME for containers in a network. To specify the network concerned by the domain name, add my_network_name: before value. Exemple :

version: '2'

networks:
  first:
    driver: bridge
  second:
    driver: bridge

services:
  web:
    image: php:7-apache
    environment:
      - "DOMAIN_NAME=first:web,first:www.web"
    networks:
      - first
      - second
  db:
    image: php:7-apache
    environment:
      - "DOMAIN_NAME=first:db,second:database"
    networks:
      - first
      - second
  mail:
    image: php:7-apache
    environment:
      - "DOMAIN_NAME=first:mail"
    networks:
      - first

will result in

## docker-hostmanager-start
172.26.0.4 ... db.dockerhostmanager_first db
172.25.0.3 ... db.dockerhostmanager_second database
172.26.0.3 ... web.dockerhostmanager_first web www.web
172.25.0.2 ... web.dockerhostmanager_second
172.26.0.2 ... mail.dockerhostmanager_first mail
## docker-hostmanager-end

iamluc · 2016-11-02T10:08:11Z

src/Synchronizer.php

@@ -126,6 +126,8 @@ private function getHostsLines($container)
        // Networks
        if (isset($container['NetworkSettings']['Networks']) && is_array($container['NetworkSettings']['Networks'])) {
            foreach ($container['NetworkSettings']['Networks'] as $networkName => $conf) {
+                preg_match(sprintf('/^%s_(.+)$/', $this->getProjectName($container)), $networkName, $matches);


Is it working with a container not created by docker compose ?
docker run ...

egeloen · 2017-02-06T16:49:06Z

@iamluc What the state of this PR? I would love to see it merged :)

iamluc · 2017-02-07T08:48:58Z

ping @Jean-Beru
Have you time to work on this ?

Jean-Beru · 2017-02-07T09:14:17Z

Not really but I will do an effort just fo you @iamluc ;-)

leokun · 2018-02-02T09:48:54Z

Hi there,
Is there any news about this PR ?

./bin/docker-hostmanager PHP Fatal error: Uncaught Error: Call to undefined method DockerHostManager\Synchronizer::getAdditionalHosts() in src/Synchronizer.php:181

Update from mykiwi

dkarlovi · 2018-04-27T07:11:12Z

Note: it seems that using this patch does work, but you need to specify the network, like so:

  web:
    environment:
      - DOMAIN_NAME=default:foo.bar

Without the default, it did not work for me. Maybe we can allow for default being equal to null so it works out of the box?

dkarlovi · 2018-04-27T07:13:23Z

@iamluc what can we do to get this built and pushed to Docker Hub? :)

iamluc · 2018-04-27T08:26:43Z

Hi @dkarlovi thanks for testing.

I'm gonna try to finish this PR with @Jean-Beru and @mykiwi in a few days.

dkarlovi · 2018-04-27T11:01:37Z

src/Synchronizer.php

@@ -126,6 +126,8 @@ private function getHostsLines($container)
        // Networks
        if (isset($container['NetworkSettings']['Networks']) && is_array($container['NetworkSettings']['Networks'])) {
            foreach ($container['NetworkSettings']['Networks'] as $networkName => $conf) {
+                preg_match(sprintf('/^%s_(.+)$/', $this->getProjectName($container)), $networkName, $matches);
+                $networkShortName = isset($matches[1]) ? $matches[1] : null;


$networkShortName = isset($matches[1]) ? $matches[1] : 'default';

should allow to not require setting the name as DOMAIN_NAME=default:foo.bar if the default network is used.

dkarlovi · 2018-05-01T07:22:04Z

BTW I've pushed this to https://hub.docker.com/r/dkarlovi/docker-hostmanager/ as a workaround, will remove it once this gets merged.

Wirone · 2018-06-03T12:19:50Z

@iamluc any news on this?

iamluc · 2018-06-11T20:31:03Z

I discussed with @Jean-Beru about this PR, and the need is not clearly defined (IMHO).

Could you tell if those examples help you to do what you want to achieve ?
https://github.com/iamluc/docker-hostmanager/pull/39/files

Any help to improve the documentation is also welcomed 😄

Wirone · 2018-06-11T20:54:41Z

@iamluc hostmanager adds some non-human-friendly Docker hosts to /etc/hosts:

## docker-hostmanager-start
172.20.0.2 reverse-proxy.traefik_loc 5b13bd735a62.traefik_loc traefik.traefik_loc
172.27.0.3 rabbitmq.arm_default 6f60c1c9caa7.arm_default arm_rabbitmq_1.arm_default
## docker-hostmanager-end

The goal here is to allow define user-friendly one(s) so it can be accessed and configured as developer wants, so instead of the lines above we can get:

## docker-hostmanager-start
172.20.0.2 traefik.loc reverse-proxy.traefik_loc 5b13bd735a62.traefik_loc traefik.traefik_loc
172.27.0.3 rabbit.loc rabbitmq.arm_default 6f60c1c9caa7.arm_default arm_rabbitmq_1.arm_default
## docker-hostmanager-end

and use traefik.loc and rabbit.loc in the browser or other tools (always, even if project's directories and/or services would change name).

iamluc · 2018-06-12T06:13:22Z

@Wirone
What I mean is that you can already do that:

version: '2'

networks:
    default:
        external:
            name: loc

services:
    traefik:
        image: traefik

    rabbit:
        image: rabbit

Will have the same result.

Of course you need to create the loc network yourself.
But it can be automated. I personally do it in a Makefile (e.g. make start)

dkarlovi · 2018-06-12T06:31:00Z

@iamluc

Of course you need to create the loc network yourself.

This makes the process a bit more complex in a cross-cutting team, as you must always ship additional tooling too. It might also lead to collisions (where multiple projects are trying to create the same external network).

Also, it doesn't allow you to have different / multiple / no suffixes if the need arises, if I understood correctly.

iamluc · 2018-06-12T07:40:33Z

This makes the process a bit more complex in a cross-cutting team, as you must always ship additional tooling too

In fact, this is not needed anymore. Since compose file version 3.5, you can change the name of the network (https://docs.docker.com/compose/compose-file/#name-1).

networks:
    default:
        name: mynetwork

Also, it doesn't allow you to have different / multiple / no suffixes

You can have define multiple networks, it will result to multiple suffix.

version: '3.5'

networks:
    default:
        name: mynetwork
    backend:
        name: backend

services:
    app:
        image: myimage
        networks:
            - default
            - backend

Indeed a suffix is required, but I don't think it is a good idea to not have one.

A very important point to me is that with this system, hostnames are the same whether you are inside a container or outside from you host, because we do the same thing docker does.

If we allow changing the hostname with a label or an env var, it will works ONLY from the host

dkarlovi · 2018-06-12T07:50:38Z

hostnames are the same whether you are inside a container or outside from you host, because we do the same thing docker does

That does sound neat. But, would it lead to problems?

For example, I wish to always use the suffix local for my projects. If I start up two separate projects at the same time, they'll both try to create redis.local even though I don't need Redis to be available at all.

Also, note that I'm using a actual valid FQDN for some of my projects to allow them to have valid Let's Encrypt certs (example, project.dev.company.com). This would mean my network name would have to be a very common TLD.

dkarlovi · 2018-07-30T09:07:31Z

Hi @iamluc, have you decided how to proceed here?

iamluc · 2018-08-01T07:37:56Z

IMHO, this feature is not needed so I will not work on it.

BUT, if someone wants to finish it, validates it is working and ensures it breaks nothing. I will agree to merge it.

dkarlovi · 2018-08-01T07:49:23Z

We've been using this since I've pushed my own image with the PR merged. It does work as expected.

iamluc · 2018-08-01T07:56:09Z

Yep, but it would be great if someone could reply to the comments:
https://github.com/iamluc/docker-hostmanager/pull/34/files#r86107703
https://github.com/iamluc/docker-hostmanager/pull/34/files#r184656291

And also document this feature in the README

dkarlovi · 2018-08-01T07:57:52Z

Fair 👍 I try to get this done in the near future.

iamluc · 2018-08-01T08:06:47Z

also, please change the target of the PR to the develop branch. This way I will test it for some days.

mykiwi · 2018-08-06T10:09:53Z

src/Synchronizer.php

@@ -136,6 +138,12 @@ private function getHostsLines($container)
                    $hosts[] = $alias.'.'.$networkName;
                }

+                foreach ($this->getAdditionalContainerHosts($container) as $host) {
+                    if (preg_match('/^(.+):(.+)$/', $host, $matches) && $matches[1] === $networkShortName) {


Why do we need this check and not directly add the host in the array ?

Wirone · 2018-12-18T10:54:29Z

src/Synchronizer.php

+    {
+        $hosts = [];
+
+        $domainName = $this->getEnv($container, 'DOMAIN_NAME');


I would like to suggest that DOMAIN_NAME is not entirely correct name for what we want to achieve with this feature. "Domain" is rather HTTP concept, but host manager can be used also for database containers instead of port binding (so developer can connect to database with client by custom host, not by localhost with bound port).

Wirone · 2019-02-26T09:39:09Z

@dkarlovi @iamluc would be good to finish this somehow... is there something we can do to get this PR merged? Using Dalibor's fork is OK, but maintaining it (keeping up-to-date) isn't something easy I think. Additionally, Dalibor's fork does NOT contain changes in readme, so sharing link to the repo isn't enough (I just sent it to my colleague and he installed iamluc/docker-hostmanager because documentation states so...).

dkarlovi · 2019-02-26T10:04:42Z

Gotta admit I've forgotten about my promise here. I'm using my image ever since I've pushed it, with my entire team (we've documented it in our project) so it's basically fire & forget currently.

@Wirone If you feel like you'd get additional value from this being merged, maybe you can take over the PR and get it merged?

Wirone · 2019-02-26T12:59:23Z

@dkarlovi how is it possible technically? PR is from @Jean-Beru's branch, if we want to continue in this PR I would need to get access to that repo 🤔? Or maybe you mean forking fork and creating new PR?

dkarlovi · 2019-02-26T13:08:25Z

You just fork this repo, add @Jean-Beru's repo as an additional remote and checkout the PR branch into your own. Any commit you make would of course be made to your own branch which gets a separate PR, but all the code is already there. Otherwise you'd need to do PRs against that repo which is inefficient.

There's some Github magic with refs which allows you to do it automagically, but I always forget how.

jlefebvre1997 · 2023-10-24T14:05:46Z

Yo, do we have to drop this one in favor of dkarlovi's one if this feature does not workas expected ? 😮

🎁 iamluc#32 - Add DOMAIN_NAME for networks

6c35054

iamluc reviewed Nov 2, 2016

View reviewed changes

mykiwi and others added 3 commits April 21, 2018 11:18

fix method name to call

053e011

./bin/docker-hostmanager PHP Fatal error: Uncaught Error: Call to undefined method DockerHostManager\Synchronizer::getAdditionalHosts() in src/Synchronizer.php:181

add check if no short network short name is found

1f343f5

Merge pull request #1 from mykiwi-forks/domain-name-for-networks

7743106

Update from mykiwi

dkarlovi reviewed Apr 27, 2018

View reviewed changes

iamluc mentioned this pull request Jun 13, 2018

docker-compose - The domain name was not added to hosts file #32

Open

mykiwi reviewed Aug 6, 2018

View reviewed changes

Wirone reviewed Dec 18, 2018

View reviewed changes

Wirone mentioned this pull request Feb 28, 2020

Local development based on Docker RocketChat/Rocket.Chat#16746

Open

iamluc mentioned this pull request Jun 11, 2021

DOMAIN_NAME environment variable not working #47

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add DOMAIN_NAME for networks #34

Add DOMAIN_NAME for networks #34

Jean-Beru commented Oct 31, 2016

iamluc Nov 2, 2016

egeloen commented Feb 6, 2017

iamluc commented Feb 7, 2017

Jean-Beru commented Feb 7, 2017

leokun commented Feb 2, 2018 •

edited

Loading

dkarlovi commented Apr 27, 2018 •

edited

Loading

dkarlovi commented Apr 27, 2018

iamluc commented Apr 27, 2018

dkarlovi Apr 27, 2018

dkarlovi commented May 1, 2018

Wirone commented Jun 3, 2018

iamluc commented Jun 11, 2018

Wirone commented Jun 11, 2018 •

edited

Loading

iamluc commented Jun 12, 2018 •

edited

Loading

dkarlovi commented Jun 12, 2018

iamluc commented Jun 12, 2018

dkarlovi commented Jun 12, 2018

dkarlovi commented Jul 30, 2018

iamluc commented Aug 1, 2018

dkarlovi commented Aug 1, 2018

iamluc commented Aug 1, 2018

dkarlovi commented Aug 1, 2018

iamluc commented Aug 1, 2018

mykiwi Aug 6, 2018

Wirone Dec 18, 2018

Wirone commented Feb 26, 2019

dkarlovi commented Feb 26, 2019

Wirone commented Feb 26, 2019

dkarlovi commented Feb 26, 2019

jlefebvre1997 commented Oct 24, 2023

Add DOMAIN_NAME for networks #34

Are you sure you want to change the base?

Add DOMAIN_NAME for networks #34

Conversation

Jean-Beru commented Oct 31, 2016

iamluc Nov 2, 2016

Choose a reason for hiding this comment

egeloen commented Feb 6, 2017

iamluc commented Feb 7, 2017

Jean-Beru commented Feb 7, 2017

leokun commented Feb 2, 2018 • edited Loading

dkarlovi commented Apr 27, 2018 • edited Loading

dkarlovi commented Apr 27, 2018

iamluc commented Apr 27, 2018

dkarlovi Apr 27, 2018

Choose a reason for hiding this comment

dkarlovi commented May 1, 2018

Wirone commented Jun 3, 2018

iamluc commented Jun 11, 2018

Wirone commented Jun 11, 2018 • edited Loading

iamluc commented Jun 12, 2018 • edited Loading

dkarlovi commented Jun 12, 2018

iamluc commented Jun 12, 2018

dkarlovi commented Jun 12, 2018

dkarlovi commented Jul 30, 2018

iamluc commented Aug 1, 2018

dkarlovi commented Aug 1, 2018

iamluc commented Aug 1, 2018

dkarlovi commented Aug 1, 2018

iamluc commented Aug 1, 2018

mykiwi Aug 6, 2018

Choose a reason for hiding this comment

Wirone Dec 18, 2018

Choose a reason for hiding this comment

Wirone commented Feb 26, 2019

dkarlovi commented Feb 26, 2019

Wirone commented Feb 26, 2019

dkarlovi commented Feb 26, 2019

jlefebvre1997 commented Oct 24, 2023

leokun commented Feb 2, 2018 •

edited

Loading

dkarlovi commented Apr 27, 2018 •

edited

Loading

Wirone commented Jun 11, 2018 •

edited

Loading

iamluc commented Jun 12, 2018 •

edited

Loading